home *** CD-ROM | disk | FTP | other *** search
/ Software of the Month Club 1998 May / Software of the Month Club 1998 May.iso / pc / dos / lg / htmlc-16 / htmlcal.doc < prev    next >
Text File  |  1998-03-03  |  12KB  |  295 lines
  1.                  **************************************
  2.                           HTMLCAL   Version 2.0
  3.                           An HTML calendar maker
  4.  
  5.                   (c) 1996, 1997 by Timothy C. Barmann
  6.                         tim@cybertalk.com
  7.                  http://www.cybertalk.com/~tim/software/
  8.                  ***************************************
  9.  
  10.  
  11. OVERVIEW
  12. --------
  13.  
  14. HTMLCAL is a shareware program that makes Web page calendars. HTMLCAL
  15. generates full-page calendars that can be posted directly to your Web
  16. site or company intranet. Use it to list upcoming events or meetings.
  17.  
  18. The calendars are designed to be viewed with both Netscape Navigator and
  19. Microsoft Internet Explorer Web browsers.
  20.  
  21. You are welcome to try out this unregistered program and the calendars it
  22. creates for 30 days. When you register, you will receive a personalized
  23. copy of HTMLCAL, plus a version that will let you create and edit your
  24. calendars directly from any Web browser.  Use it to coordinate meetings or
  25. projects for your company, or set up a community event calendar that anyone
  26. can access and add events to.
  27.  
  28. The program costs either $10 or $20, depending on who you are and what you
  29. will use it for. See the registration section, or REGISTER.DOC for more
  30. information.
  31.  
  32.  
  33. I. HOW TO USE HTMLCAL
  34. ---------------------
  35.  
  36. HTMLCAL works from the DOS or Unix command line.
  37.  
  38. Usage:
  39.  
  40.  C:\>HTMLCAL   (you will be prompted for month and year) 
  41.  
  42.  C:\>HTMLCAL [/mMM][-MM] /yYYYY] [/eEvents] [/hHeader] [/fFooter] [/a] [/b]
  43.  
  44. WHERE:
  45.  
  46.         MM-MM is the month or range of months desired.
  47.  
  48.         YYYY is the year to create calendars for.
  49.  
  50.         Events is the file name of events to place on calendars. See below
  51.             for description of the events file format. By default, if no
  52.             events file is listed, HTMLCAL looks for a file with a name
  53.             comprised of the current year, with an extension of DAT. For 1998,
  54.             the program looks for a file called 1998.dat. This file is
  55.             optional.
  56.  
  57.         Header is the file name of HTML source you want to appear at the
  58.             top of all the calendars. Place in this file HTML code for a logo
  59.             background color, etc. By default, if a header file is not
  60.             specified, HTMLCAL looks for a file called HEADER.HTM. This file
  61.             is optional.
  62.  
  63.         Footer is the filename of HTML source you want to appear at the
  64.             bottom of all the calendars. Place in this file HTML source for
  65.             things such as links to a home page. By default, if a footer file
  66.             is not specified, HTMLCAL looks for a file called FOOTER.HTM.
  67.             This file is optional.
  68.  
  69.         /a is Auto mode. This optional command is used by itself and allows
  70.             you to create calendars for each month of the current year without
  71.             having to enter any other parameters.
  72.  
  73.         /b Turns OFF the link bar which otherwise will be appended to the
  74.             bottom of each calendar. The link bar lets the user switch to any
  75.             other month by clicking on it. By default, if you don't use this
  76.             command, the link bar will be placed below the calendar. It looks
  77.             like this:
  78.  
  79.     Jan | Feb | Mar | Apr | May | Jun | Jul | Aug | Sep | Oct | Nov | Dec
  80.  
  81.  EXAMPLES
  82.  --------
  83.  
  84.  To create all 12 calendars for the current year, enter:
  85.    HTMLCAL /a
  86.  
  87.  To make a series of calendars for July through December in 1998, enter:
  88.  
  89.     HTMLCAL /y1998 /m7-12
  90.  
  91.  For July only, enter:
  92.  
  93.     HTMLCAL /y1998 /m7
  94.  
  95. To make a series of calendars using an events list called myevents.dat from
  96. May to Nov., 1998, turning off the link bar:
  97.  
  98.     HTMLCAL /m5-11 /y1998 /fmyevents.dat /b
  99.  
  100. To make a series of calendars using an events list called spring.dat, a header
  101. file called head.htm and a footer file called foot.htm, for March, April and
  102. May, 1999:
  103.  
  104.     HTMLCAL /m3-5 /y1999 /espring.dat /hhead.htm /ffoot.htm
  105.  
  106. -----------------------------------------------------------------------------
  107. Events file format
  108.  
  109. The shareware version of HTMLCAL requires that you enter events in a data
  110. file, while the registered version also allows editing directly from a Web
  111. page form.
  112.  
  113. The events file by default is called xxxx.dat, where xxxx is the year. For
  114. example, events for 1998 should be stored in a file called 1998.dat
  115.  
  116. The events file is a plain, ASCII text file. Up to 200 events can be stored
  117. in the events file. (Any beyond that is ignored by HTMLCAL.)
  118.  
  119. The events file holds the dates of the events and a description, in this
  120. format:
  121.  
  122.  07 04 Independence Day
  123.  ^^ ^^ ^^^^^^^^^^^^^^^^
  124.  |  |  |--  The DESCRIPTION field begins at the 7th character. It can be
  125.  |  |       up to 255 characters long, and must end with a carriage return.
  126.  |  |
  127.  |  |------ The DAY of the month field begins at the 4th character
  128.  |          position. Pad single digit dates with a 0, as in this example.
  129.  |
  130.  |--------------- The MONTH field begins at the 1st character on a new
  131.                  line. Pad single digit months with a 0, as in this
  132.                  example.
  133.  
  134. The 3rd and 6th character should be a space.
  135.  
  136. The events file should contain all the events for every calendar you are
  137. creating. For example, it you are creating a year's worth of calendars at one
  138. time, you only need to maintain one events file. HTMLCAL will search through
  139. the events file for each calendar it makes, looking for the relevant dates.
  140. It's not necessary to put events in chronological order in the events file.
  141.  
  142. The description field in the events file can also contain HTML code, so the
  143. event can link to another Web page. For example, lets say you wanted to link
  144. to a Web site with directions to a July 4th party on your July calendar. It
  145. might be listed in your events file this way:
  146.  
  147. 07 04 <a href="http://www.someplace.org/party/">Directions to party</a>
  148.  
  149. Each event, including the date, description, and optional link information,
  150. cannot exceed 255 characters, and must end with a carriage return. Do not break
  151. up a long description with carriage returns. (You must use a word processor that
  152. allows you to create lines more than 80 characters long do to this.)
  153.  
  154. The events file can have comments. Commented lines must begin with a semicolon
  155. (;) as the first character:
  156.  
  157. ; This is an example of a comment in the events file. HTMLCAL
  158. ; will ignore these lines.
  159.  
  160. Multiple events on the same day will be automatically separated by a horizontal
  161. line.
  162.  
  163. II. CUSTOMIZING THE CALENDARS
  164. -----------------------------
  165.  
  166. header.htm
  167.  
  168. Use a header file (header.htm) if you want your calendars to have a particular
  169. wallpaper or background color. This is also where you can put a link to an
  170. image, such as your organization's logo, that you want to appear at the top of
  171. all the calendars you create.
  172.  
  173. A typical header file, written in HTML, might contain this code:
  174.  
  175.  <BODY BGCOLOR="#FFFFFF">
  176.  <IMG SRC="LOGO.GIF">
  177.  <HR>
  178.  
  179. This will make the background in all of your calendars white, and will add the
  180. file "logo.gif" to the top of all calendars, and add a horizontal rule.
  181.  
  182. Note that it is not necessary to use a header file. By default, if a header
  183. file is not specified, HTMLCAL looks for a file called HEADER.HTM. If HTMLCAL
  184. doesn't find a header file, it will automatically inserts a <BODY> command in
  185. all the calendars.
  186.  
  187. See an HTML reference book for further help with the code.
  188.  
  189. footer.htm
  190.  
  191. Use a footer file to add something to the bottom of each calendar. A typical
  192. use would be to add a set of links to other sites, such as a home page.
  193.  
  194. A typical footer, written in HTML, might look like this:
  195.  
  196.  <CENTER>
  197.  | <A HREF="http://www.mysite.com/">HOME PAGE</A> |
  198.  </CENTER>
  199.  
  200. This would place a link to http://www.mysite.com at the bottom of each
  201. calendar.
  202.  
  203. See an HTML reference manual for further explanation of the code.
  204.  
  205. As with the header file, the footer file is optional. If none is specified on
  206. the command line, by default, HTMLCAL looks for a file called FOOTER.HTM.
  207.  
  208.  
  209. III. BUGS AND LIMITATIONS
  210. -------------------------
  211.  
  212. HTMLCAL can handle up to 200 events listed in the events file. Any beyond that
  213. are ignored by the program.
  214.  
  215. Please send any questions, comments or bug reports to me at: tim@cybertalk.com,
  216. or stop by my home page at http://www.cybertalk.com/~tim/
  217.  
  218. IV. VERSION CHANGES AND ENHANCEMENTS
  219. ------------------------------------
  220.  
  221.  Version 2.0, June 1997
  222.   * Web calendars display date and time they were generated
  223.   * Auto mode introduced that creates a calendar for every month of the
  224.     current year
  225.   * Added support for Microsoft Internet Explorer
  226.   * Made each column fixed width, regardless of the events listed
  227.   * The Unix version now create calendars with the htm extension
  228.   * Now supports multiple events listed on the same day
  229.   * Calendars include a no-cache command, to allow for browsers to
  230.     automatically load dynamically generated calendars
  231.   * New file name convention used for events data file that incorporates the year
  232.  
  233.  Version 1.0, April 1996
  234.   * Initial version
  235.  
  236. V. REGISTRATION
  237. ---------------
  238.  
  239. HTMLCAL is shareware. You may use it and the calendars it creates for 30 days for free.
  240. After that time, you must register the program or stop using it and the calendars it
  241. generated.
  242.  
  243. You must register a copy for each site that you intend to generate calendars for.
  244. That is, if you are the webmaster for www.yourdomain.com and www.hisdomain.com, you'll
  245. need to register two copies.
  246.  
  247. You can register by filling out page enclosed with this package called REGISTER.DOC.
  248. Fill it out and mail it to the address below along with payment in U.S. funds.
  249. Registration is $10 for individuals or $20  for groups, businesses, organizations, 
  250. schools, non-profits, etc.
  251.  
  252. Send your registration to:
  253.  
  254. Timothy Barmann
  255. P.O. Box 1145
  256. Providence, R.I. 02901
  257.  
  258. Add an additional $3 if you want the program delivered on disk to anywhere in the
  259. continental U.S. (Please e-mail me for overseas postage rates.)
  260.  
  261. Registering will bring you the latest version, plus the necessary CGI programs to allow
  262. you to create and edit the calendars directly from a Web page. You must be able to
  263. install CGI programs on your Web server to make this feature work. Ask your Internet
  264. Service Provider if they allow you to do so if you are unsure. Note that the CGI editing
  265. programs are compiled to run on two of the most popular Web server platforms:
  266. Windows NT/95 and Unix (SunOS 4.1.3). The HTMLCAL home page explains this in more
  267. detail at http://www.cybertalk.com/~tim/software/. Click on Frequently asked questions
  268. for more details.
  269.  
  270. Contact the author at tim@cybertalk.com with any questions.
  271.  
  272.  
  273. VI. LEGALESE
  274. ------------ 
  275.  
  276. The shareware version of HTMLCAL is not free software. You are required to
  277. register this program if you use it or the calendars it creates for more
  278. than 30 days.  Please see the file REGISTER.DOC for complete registration
  279. information.
  280.  
  281. The HTML code generated by HTMLCAL is (c) copyrighted by Timothy C. Barmann.
  282. You may not replicate or reuse the HTML code in whole or in part.
  283.  
  284. Use this program at your own risk. While I've made considerable effort to make
  285. sure this program works properly, I am not responsible for any damage or loss
  286. of data, or any other loss that occurs from its use or misuse. No warranty is
  287. expressed or implied. I will give technical support by e-mail.
  288.  
  289. VII. CONTACT THE AUTHOR
  290. -----------------------
  291.  
  292. If you encounter any problems with HTMLCAL, please contact me, Timothy C.
  293. Barmann, at tim@cybertalk.com. That will bring you the fastest response, but 
  294. you may also write to me at P.O. Box 1145, Providence, RI 02901.
  295.